ProfileApiData
The Profile definition object contains the definition for a user profile.
API Section: Objects
Type: Object
Properties
Name |
Description |
Required |
Type |
Format |
---|---|---|---|---|
profileId |
The system ID of the profile. When adding a profile, the provided GUID will be used if supplied. Otherwise, the function will auto-create it. |
- |
string |
|
name |
Profile's name or caption |
Y |
string |
|
description |
Profile's description |
Y |
string |
|
permissions |
The functional items to be available in the profile as either a list or the sum bit indexes. The list will take priority if both are supplied |
Y |
||
tenantId |
The profile's tenant (ID) |
Y |
string |
*Required elements are only used for API parameters